home *** CD-ROM | disk | FTP | other *** search
- /* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 2 -*- */
- /* ***** BEGIN LICENSE BLOCK *****
- * Version: MPL 1.1/GPL 2.0/LGPL 2.1
- *
- * The contents of this file are subject to the Mozilla Public License Version
- * 1.1 (the "License"); you may not use this file except in compliance with
- * the License. You may obtain a copy of the License at
- * http://www.mozilla.org/MPL/
- *
- * Software distributed under the License is distributed on an "AS IS" basis,
- * WITHOUT WARRANTY OF ANY KIND, either express or implied. See the License
- * for the specific language governing rights and limitations under the
- * License.
- *
- * The Original Code is mozilla.org code.
- *
- * The Initial Developer of the Original Code is
- * Netscape Communications Corporation.
- * Portions created by the Initial Developer are Copyright (C) 1998
- * the Initial Developer. All Rights Reserved.
- *
- * Contributor(s):
- *
- * Alternatively, the contents of this file may be used under the terms of
- * either of the GNU General Public License Version 2 or later (the "GPL"),
- * or the GNU Lesser General Public License Version 2.1 or later (the "LGPL"),
- * in which case the provisions of the GPL or the LGPL are applicable instead
- * of those above. If you wish to allow use of your version of this file only
- * under the terms of either the GPL or the LGPL, and not to allow others to
- * use your version of this file under the terms of the MPL, indicate your
- * decision by deleting the provisions above and replace them with the notice
- * and other provisions required by the GPL or the LGPL. If you do not delete
- * the provisions above, a recipient may use your version of this file under
- * the terms of any one of the MPL, the GPL or the LGPL.
- *
- * ***** END LICENSE BLOCK ***** */
-
- #ifndef __nsIContentIterator_h___
- #define __nsIContentIterator_h___
-
- #include "nsISupports.h"
-
- class nsIContent;
- class nsIDOMRange;
-
- #define NS_ICONTENTITERTOR_IID \
- {0xa6cf90e4, 0x15b3, 0x11d2, \
- {0x93, 0x2e, 0x00, 0x80, 0x5f, 0x8a, 0xdd, 0x32} }
-
- // {B4BC9F63-D9BA-11d3-9938-00108301233C}
- #define NS_IGENERATEDCONTENTITERTOR_IID \
- { 0xb4bc9f63, 0xd9ba, 0x11d3, \
- { 0x99, 0x38, 0x0, 0x10, 0x83, 0x1, 0x23, 0x3c } }
-
-
- class nsIContentIterator : public nsISupports
- {
- public:
- NS_DEFINE_STATIC_IID_ACCESSOR(NS_ICONTENTITERTOR_IID)
-
- /* Initializes an iterator for the subtree rooted by the node aRoot
- */
- virtual nsresult Init(nsIContent* aRoot) = 0;
-
- /* Initializes an iterator for the subtree defined by the range aRange
- */
- virtual nsresult Init(nsIDOMRange* aRange) = 0;
-
- /** First will reset the list.
- */
- virtual void First() = 0;
-
- /** Last will reset the list to the end.
- */
- virtual void Last() = 0;
-
- /** Next will advance the list.
- */
- virtual void Next() = 0;
-
- /** Prev will decrement the list.
- */
- virtual void Prev() = 0;
-
- /** CurrentItem will return the current item, or null if the list is empty
- * @return the current node
- */
- virtual nsIContent *GetCurrentNode() = 0;
-
- /** return if the collection is at the end. that is the beginning following a call to Prev
- * and it is the end of the list following a call to next
- * @return if the iterator is done.
- */
- virtual PRBool IsDone() = 0;
-
- /** PositionAt will position the iterator to the supplied node
- */
- virtual nsresult PositionAt(nsIContent* aCurNode) = 0;
- };
-
- class nsIPresShell;
-
- class nsIGeneratedContentIterator : public nsISupports {
- public:
-
- NS_DEFINE_STATIC_IID_ACCESSOR(NS_IGENERATEDCONTENTITERTOR_IID)
-
- /* Initializes an iterator for the subtree rooted by the node aRoot
- */
- virtual nsresult Init(nsIPresShell *aShell, nsIDOMRange* aRange) = 0;
-
- virtual nsresult Init(nsIPresShell *aShell, nsIContent* aContent) = 0;
- };
-
-
- #endif // __nsIContentIterator_h___
-
-